Detach Customer Product

This API is used to detach (deallocate) a single product instance from a single sub-customer.

Developer Notes: Reject any request to detach an offer whose “planType” is not “ACCOUNT_PRODUCT”.

HTTP URL
DELETE	/api/v2/customer/{id}/detach-product/{id}

Note: The second {id} is the product instance ID that should be detached (deallocated).

Eligibility

The Requestor is eligible to detach a product from his sub-customers only. It is not allowed to detach a product from any other level of the customer hierarchy.

API Request

Request Structure

N/A

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code. See list below, under ‘Error Codes’ section.
errorMessage	String	O	Failure detailed description. See list below, under ‘Error Codes’ section.
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content data objects

Element	Type	M/O/CM	Description
requestId	UUID	M	Request instance ID. To be used by external systems to query the call (operation) status, whether in progress, successful or failed.

Pageable data objects

Element	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again
CUSTOMER_1049	Failed to detach product instance

Examples

Request Body

Copy

{
}

Response Body: Success ACK

Copy

{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Failure NAK

Copy

{
  "errorCode": "CUSTOMER_1049",
  "errorMessage": "Failed to detach product instance",
  "content": "",
  "pageable": null
}